home *** CD-ROM | disk | FTP | other *** search
/ TOS Silver 2000 / TOS Silver 2000.iso / online / HTMLCONV / HTMLCONV.ENG < prev    next >
Encoding:
Text File  |  1997-04-15  |  6.6 KB  |  184 lines
  1.                               HTML TEXT CONVERTER
  2.                               ===================
  3.  
  4.  
  5. Yes, I know nobody reads documentations, but who cares !  8-)
  6.  
  7.  
  8. *********************************** CONTENTS ***********************************
  9.  
  10. 1. What's that ?
  11.    1.1. Quick description
  12.    1.2. How to use it
  13. 2. Remarks
  14.    2.1. Generated HTML files
  15.    2.2. Converted characters
  16. 3. Old and future versions
  17. 4. Bugs ?
  18. 5. Contact and copyright
  19.  
  20. ********************************************************************************
  21.  
  22.  
  23. 1. What's that ?
  24. ================
  25.  
  26. This version 1.3 of HTML TEXT CONVERTER was 100% coded in GFA Basic 3.
  27.  
  28.      1.1. Quick description
  29.      ----------------------
  30.  
  31. Well, I don't want to explain you what the HTML language is, this software was
  32. made for people who would like to make HTML pages with ASCII text.
  33.  
  34. HTML TEXT CONVERTER can do two things :
  35. - it can convert an ASCII file into HTML format with the header, carriage return
  36.   and so on,
  37. - it can convert ASCII accents into HTML accents.
  38.  
  39. I've coded it in order to help me when I'm making HTML pages with ASCII texts.
  40. In fact, I intensively use it for the Toxic Mag (a French diskmagazine for the
  41. Atari computers, see my address).
  42.  
  43.      1.2. How to use it
  44.      ------------------
  45.  
  46. When HTML TEXT CONVERTER starts, there is a dialog box and 4 options :
  47.  
  48. - Convert from an ASCII text : HTML TEXT CONVERTER will modify your text and
  49.   will partially translate it into HTML format. As the conversion is not perfect
  50.   (perfect things don't exist on Earth), always use a text editor after using
  51.   HTML TEXT CONVERTER. See section 2 to have info about the generated files.
  52.  
  53. - Only convert accents : HTML TEXT CONVERTER will translate the classic accents
  54.   into HTML accents. for instance, "ô" will become "ô" and "à" will become
  55.   "à". The aim of this option is to kill ASCII accents in an HTML page. I
  56.   guess you will use many more times the first option !
  57.   Note that here the "<", ">" and "&" are not converted.
  58.  
  59. - Info : about HTML TEXT CONVERTER
  60.  
  61. - Exit : well...
  62.  
  63.  
  64. 2. Remarks
  65. ==========
  66.  
  67.      2.1. Generated HTML files
  68.      -------------------------
  69.  
  70. HTML TEXT CONVERTER will always add modifications to ASCII files, so the lenght
  71. of the HTML files will always be greater. What's inside an HTML file generated
  72. by HTML TEXT CONVERTER ?
  73.  
  74. First of all, HTML TEXT CONVERTER will add a remark (so it won't be taken into
  75. consideration by you favorite HTML browser) and will display that IT has
  76. converted the file. It will add my name, the date and the time of the conversion
  77. too (it can be useful).
  78.  
  79. It will also add a header :
  80.   <html>
  81.   <head><title> (...) </title></head>
  82.   <body>
  83. Don't forget the title !
  84.  
  85. If a line of your ASCII file begins with a "-", the software will think that's
  86. an enumeration and it will add a carriage return symbol at the end :
  87.   <br>
  88. But that's not always an enumeration, so don't forget to use your favorite text
  89. editor !  8-)
  90.  
  91. If HTML TEXT CONVERTER notes an empty lines, it will put this instead :
  92.   <br><p>
  93. It means : carriage return and new paragraph.
  94.  
  95. And, last but not least, the software adds this at the end of the HTML file :
  96.   </body>
  97.   </html>
  98. (Enjoy !)
  99.  
  100.      2.2. Converted characters
  101.      -------------------------
  102.  
  103. As almost all the accents are recognized, I won't give you the complete list
  104. here, it's a complete waste of time. Only the rarest accents ("ø", "Ø", "ª" and
  105. "º") aren't recognized yet. All the accents in the latin languages (Italian,
  106. French, Spanish, Portuguese...) are recognized.
  107.  
  108. Note that HTML TEXT CONVERTER will convert these special characters too : "ç",
  109. "Ç", "ñ", "Ñ", "æ" and "Æ". The "œ" and "Œ" are also recognized but they are
  110. replaced by "oe" and "OE" (that's not on my fault, it is due to HTML language
  111. itself !). The copyright character ("©") is converted into HTML too.
  112.  
  113. The "&", "<" and ">" characters are only translated if you choose the "Convert
  114. from an ASCII text" option. That's normal because these characters are used by
  115. HTML language.
  116.  
  117.  
  118. 3. Old and future versions
  119. ==========================
  120.  
  121. Version 1.0 from April 4th, 1997 :
  122. - Crappy non-GEM interface
  123. - Doesn't recognize the end of files yet  8-(
  124.  
  125. Version 1.1 from April 5th, 1997 :
  126. - Now it recognize the end of files
  127. - French accents only
  128.  
  129. Version 1.2 from April 10th, 1997 :
  130. - The dialog box has changed (there is an RSC file now)
  131. - More and more accents are recognized
  132. - And all this in a few hours only : yo ! Coding GEM in GFA is good !  ;-)
  133.  
  134. Version 1.3 from April 15th, 1997 :
  135. - The "©", "&", "<" and ">" characters are recognized
  136. - Almost all the accents are recognized
  137. - A bug of the interface has been removed (the dialog box was selectable !)
  138.  
  139. Planed for future versions :
  140. - Options will appear. You will be able to set up :
  141.   - If you want the destination path to be the same that source path or not
  142.   - If the software must put the time and the date at the beginning the the
  143.     freshly converted HTML text
  144.   - If you want the software puts "<br>" at the end of lines which end with "-"
  145. - You will be able to save the options (cheers !)
  146. - Conversion of ALL accents on Earth and all letters with a "tilda" (e.g. ñ")
  147. - Well, I don't have ideas no more... Could you help me ?
  148.  
  149.  
  150. 4. Bugs ?
  151. =========
  152.  
  153. - The source and destination files mustn't be the same and musn't be on two
  154. different diskettes 'coz HTML TEXT CONVERTER opens these files simultaneously
  155. (it uses less RAM and it's easier to manage !).
  156.  
  157. - The last line MUST be a blank line else there will be an EOF error (Error #26)
  158. or 2 bombs (but it won't be too serious... well I hope !).
  159.  
  160. - HTML TEXT CONVERTER was created and tested on Falcon 030 and should work with
  161. ALL Atari computers and clones on this planet. If it doesn't work on your
  162. computer then get in touch with me !
  163.  
  164. - Contact me if you find other bugs !
  165.  
  166.  
  167. 5. Contact and copyright (the boring bits)
  168. ========================
  169.  
  170. HTML TEXT CONVERTER is postcardware. It means you HAVE TO send me a beautiful
  171. postcard if you enjoy it, if you often use it or if you've installed it on your
  172. hard disk or a CD-Rom.
  173. If people send me postcards then I will code other versions. If nobody sends me
  174. a postcard, I will stop coding future versions of HTML TEXT CONVERTER.
  175. Well, I can't reply all the postcards because stamps aren't so cheap. But you
  176. still can tell me your e-mail address (who cares !).
  177.  
  178. Contact me at :  PEREZ Stéphane
  179.                  328, Les Hauts du Louvarou
  180.                  38560 HAUTE-JARRIE
  181.  
  182. Along with HTML TEXT CONVERTER, you will find a "FILE_ID.DIZ" file and a French
  183. documentation. Have a nice day (or night ?) !!!
  184.